Documentation - Github pages #267
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This looks great, thanks! I would love to use a separate repo for this documentation, because having ~150 files in the main repo only for documentation seems a bit too much. Could you make a PR to a new repo that I just created? https://github.com/nvim-orgmode/docs |
|
Ok I've moved the PR there nvim-orgmode/nvim-orgmode.github.io#1 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I created a Read the Docs themed Sphinx version of the README and plugged it in to GitHub Pages. I've also added a Getting Started section as suggested in #183.
It looks really nice 😎 https://gerazov.github.io/orgmode/
I was following Continuous Documentation: Hosting Read the Docs on GitHub Pages up to the automation part.
The documentation in
rstformat is in./docs_rst/and the compiled website in./docs- this is the only folder that can be specified other than root for gh-pages to work.I've currently compiled the
rstlocaljy tohtmlusingpython-sphinxandmake html, which generates thehtmlin the./docs_rst/_build/html/folder. I then copied this to./docsand activated gh-pages on thedocumentationbranch and the./docsfolder.I've done this manually just so I can share the way it looks. In the main repo it should be automated via scripts as described in Continuous Documentation: Hosting Read the Docs on GitHub Pages